DELETE Live Channel
Overview
The table below provides key details about the DELETE method for removing a channel.
| Delete Live Channel | |
|---|---|
| Method | DELETE |
| URL or Endpoint | /api/v1/projectId/channels/id |
| Headers | Authorization |
| Parameters | id, projectId |
The description of the URL parameter is as follows:
| Id URL Parameter | |
|---|---|
| URL Parameter Name | Id |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the channel. |
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
Request Body
The request does not have a request body
Response
{
"success": true,
"errors": [],
"messages": [],
"result": true,
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | bool | Return a boolean value based on the result of the response. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed